provider Snapshots POST /api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/preprodartifacts/snapshots/
@utdk/sentry /api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/preprodartifacts/snapshots/
Upload a Snapshot
Upload a new snapshot with image metadata. The request body is a JSON object containing `app_id` (required), `images` (required, a mapping of filenames to image metadata objects), and optional VCS fields (`head_sha`, `base_sha`, `provider`, `head_repo_name`, `head_ref`, `base_repo_name`, `base_ref`, `pr_number`). When VCS info with a `base_sha` is provided and a matching base snapshot exists, a comparison is automatically triggered. This endpoint requires a bearer token with `project:write` access.
organization_id_or_slug path required
The ID or slug of the organization the resource belongs to.
string
project_id_or_slug path required
The ID or slug of the project the resource belongs to.
string

Try it

Authentication
Configure credentials for API Reference
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

uploadASnapshot
POST/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/preprodartifacts/snapshots/
Upload a new snapshot with image metadata. The request body is a JSON object containing `app_id` (required), `images` (required, a mapping of filenames to image metadata objects), and optional VCS fields (`head_sha`, `base_sha`, `provider`, `head_repo_name`, `head_ref`, `base_repo_name`, `base_ref`, `pr_number`). When VCS info with a `base_sha` is provided and a matching base snapshot exists, a comparison is automatically triggered. This endpoint requires a bearer token with `project:write` access.

Parameters

required

The ID or slug of the organization the resource belongs to.

required

The ID or slug of the project the resource belongs to.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import sentry from '@utdk/sentry';

await sentry.uploadASnapshot()